home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 11 / Cream of the Crop 11-2.iso / extra / zen096.zip / ZENNODE.DOC < prev   
Text File  |  1995-11-29  |  6KB  |  128 lines
  1.  
  2.  
  3.          ZenNode - Possibly the fastest DOOM(tm) BSP builder yet.
  4.  
  5.            Version 0.96 by Marc Rousseau (rousseaum@pictel.com)
  6.  
  7.  
  8. BACKGROUND:
  9.  
  10.     After playing around with a few level editors for DOOM, I noticed that
  11. most of them took a long time to build the NODES structure.  Even worse, some
  12. of them built NODES that didn't work!  So, I decided I'd try writing a
  13. NODES builder that 1) built valid NODES and 2) built them FAST.  Well, after
  14. a month or two of fooling around, ZenNode is here.  I believe both objectives
  15. have been reached.  I've compared it to several other NODES builders out there
  16. and it blows them all away!  It's written entirely in C/C++ ( actually the 
  17. OS/2 version now has two routines in assembly ).  It could probably be sped up
  18. with a little assembly code ( or a better optimizing compiler ).
  19.  
  20.     This .ZIP file contains essentially a beta of ZenNode.  I'm still working
  21. on a few more features, but it is a fully functional NODES builder for DOOM
  22. .WAD files.  ZenNode will rebuild either a single level or all the levels in
  23. a .WAD file.  This version will accept either DOOM, DOOM II, Heretic, and/or 
  24. HEXEN .WADs.  Try it out.  Let me know what you think.
  25.  
  26.  
  27. DESCRIPTION:
  28.  
  29.     ZenNode will read the level description from a .WAD file and create either
  30. a new BLOCKMAP resource, REJECT resource, and/or NODES/SEGS/SSECTOR resources.
  31. Levels in a .WAD may be specified on the command line, or, if none are 
  32. specified, all of the maps in a .WAD will be rebuilt.
  33.  
  34.     As it completes a resource, ZenNode will print some information indicating
  35. the results.  When a BLOCKMAP is completed, it will display the new/old size 
  36. of the block map and a percentage of the block map that is actually used by
  37. the map.  After it rebuilds the BSP tree, it will display the number of new/
  38. old NODES and SEGS that it created along with the original numbers.
  39.  
  40.  
  41. NEW FEATURES:
  42.  
  43. Version 0.96:
  44.  
  45.     Support for 'special effects' has been improved.  Using the /nu switch, 
  46. you can affect the creation of sub-sectors.  What this means ( for those of
  47. you who don't know/care what a sub-sector is ) is that you can get most of
  48. the special effects to work in your .WAD file.  By default all sub-sectors
  49. are unique.  This works with most special effects ( ie: deep-water, invisible
  50. stairs, ... ).  If the effect you're trying to achieve doesn't work, try
  51. turning off this feature with /nu-.  This works for other effects, such as
  52. light striking a wall from no visible source ( different sector ).
  53.  
  54.     For those of you who think ZenNode is too slow <g>, there's a new method 
  55. for partitioning available for you!  Both of the existing algorithms examine
  56. every valid segment to see if they should be used as the partition for a node.
  57. Examining every segment can slow things down, so if you really can't wait, if
  58. ZenNode is way too slow for you, try the new algorithm.  It only looks at a
  59. small sub-set of segments instead ( saving you valuable seconds that could be
  60. used testing your new .WAD ).
  61.  
  62.     You can now 'customize' ZenNodes partitioning logic!  The formula used to
  63. determine the merit of a particular SEG is now user adjustable.  You can now
  64. set the four coefficients used in the calculation.  If you don't like the
  65. way ZenNode picks lines, or you just want to experiment, now you can actually
  66. do something about it.  The metric formula used is:
  67.  
  68.     metric = ( L * R ) / ( x1 * S / x2 ) - ( x3 * S + x4 ) * S;
  69.  
  70. Where L, R, and S represent the # of SEGS to the left, right, and split by the
  71. candidate SEG.  Checks are made to avoid division by zero.  The programmable 
  72. values x1, x2, x3, and x4 can be modified by setting the environment variables
  73. ZEN_X1, ZEN_X2, ZEN_X3, and ZEN_X4 respectively.  The default settings are: 
  74. x1=24, x2=5, x3 = 1, x4=25.  ( Older versions of ZenNode used the values x1=4
  75. or 5, x2=1, x3=0, x4=0 ).  Algorithm 2 also uses a similar set of variables, 
  76. ZEN_Y1, ZEN_Y2, ZEN_Y3, and ZEN_Y4, where L, R, and S represent sectors rather
  77. than SEGS.  The default settings are: y1=0, y2=1, y3=1, y4=5 ).  Have fun.
  78.  
  79.  
  80. Version 0.95:
  81.  
  82.     Support for Hexen has been added.  This has been largely untested, but a 
  83. quick test of the hexen.wad file seems to be working.  So, as soon as you get
  84. your favorite WAD Editor to support Hexen, ZenNode will be ready!
  85.  
  86.     ZenNode now offers two methods of partitioning your level.  The new method
  87. makes an attempt to minimize the average depth of the BSP tree.  This should
  88. make it slightly faster for the DOOM engine to render a screen, since it has
  89. to traverse fewer NODES each time.  The original method is still intact and
  90. attempts to minimize the number of splits made.  Currenty the new method has
  91. not been optimized for speed but it is still reasonably fast.
  92.  
  93.     BSPInfo has been included to allow you to gather information about how
  94. your node builders compare to each other.  You can see if one favors certain
  95. characteristics over others, or just get an overall feel for their performance.
  96.  
  97.  
  98. REQUIREMENTS:
  99.  
  100.    1) A machine capable of running DOOM - 386 or better with a few Meg of RAM
  101.    2) A supported operating:
  102.       a) OS/2 2.0 or higher
  103.       b) DOS ( v?.?? or higher - tested with 5.0 & 6.22 )
  104.       c) a Win32 platform ( Windows NT or Windows 9x )
  105.    3) A .WAD file
  106.  
  107.  
  108. ACKNOWLEDGMENTS:
  109.  
  110.        DOOM & DOOM II are trademarks of id Software, inc.,(C)1994.
  111.        Heretic & HEXEN were developed by Raven Software for id Software.
  112.  
  113.  ■ Thanks to the guys at id Software for creating DOOM.
  114.  ■ Thanks to Raven Software for putting out Heretic & Hexen.
  115.  ■ Matt Fell and everyone who helped put together the unofficial DOOM specs.
  116.    This program was written entirely from the descriptions in this file and
  117.    wouldn't have been possible without it.
  118.  
  119.  
  120. DISCLAIMER:
  121.  
  122. I've tested the .WADs generated by ZenNode and haven't found any fatal errors
  123. or HOM (Hall-of-mirrors) side-effects from any level I've tested.  However,
  124. by using this program you assume all responsibility for lost/damaged files
  125. resulting from the use of a .WAD generated by ZenNode.  If you find a level
  126. that causes either an error in ZenNode, HOMs, or any other problem inside
  127. DOOM, please let me know.
  128.